home *** CD-ROM | disk | FTP | other *** search
/ Light ROM 1 / LIGHT-ROM 1 (Amiga Library Services)(1994).iso / ffdisks / d875.lha / ADoc / ADoc.doc < prev    next >
Text File  |  1993-02-14  |  29KB  |  596 lines
  1.  
  2.  
  3. AboutThisDoc
  4.  
  5.       Ce manuel décrit la version 3.00 de l'utilitaire ADoc2. Ce  programme
  6.   est (c)1990-1991-1992-1993 par Denis GOUNELLE, toute utilisation  commerciale
  7.   ou vente sans autorisation écrite  est  strictement  interdite.  Vous  pouvez
  8.   copier et diffuser ce programme aux conditions suivantes :
  9.  
  10.     - l'ensemble des fichiers doit être fourni
  11.     - aucun fichier ne doit avoir été modifié
  12.     - vous ne devez pas demander plus de 40FF pour cela
  13.  
  14.       "PowerPacker 2.3b"  est  (c)1989  par  PowerPeak  et  Nico  FRANCOIS,
  15.   "PowerPacker Pro 3.0b" est (c)1990 par PowerPeak  et  par  UGA  Software.  La
  16.   bibliothèque    "powerpacker.library"  est  (c)1990  par  Nico   FRANCOIS.   La
  17.   bibliothèque "reqtools.library" est (c)1991-1992 par Nico FRANCOIS. AREXX est
  18.   (c)1987 par William Hawes.
  19.  
  20.       Malgré de nombreux tests, je ne peux    garantir  qu'ADoc  ne  contient
  21.   aucune erreur. VOUS UTILISEZ CE PROGRAMME A VOS  RISQUES  ET    PERILS.  Je  ne
  22.   pourrai en aucun cas    être  tenu  responsable  de  tout  dommage,  direct  ou
  23.   indirect, résultant de l'utilisation d'ADoc.
  24.  
  25.            >>> FERMEZ CETTE FENETRE POUR CONTINUER <<<
  26.  
  27. Introduction
  28.  
  29.       ADoc2 est une nouvelle version de ADoc, qui a été réécrit entièrement
  30.   afin de supprimer certaines limitations et de pouvoir ajouter  de  nombreuses
  31.   améliorations.  Notez   que    certaines   incompatibilités   sont   apparues,
  32.   principalement au niveau des arguments. Ce programme fonctionne  de  la  même
  33.   façon sous les versions 1.3 et 2.0 du système.
  34.       ADoc est un utilitaire permettant de    gérer  des  documentations  sur
  35.   n'importe quel sujet. Il est capable de lancer automatiquement  la  recherche
  36.   d'un mot désigné à la souris, et peut travailler sur plusieurs fichiers à  la
  37.   fois. ADoc peut  également  utiliser    directement  les  fichiers  AutoDoc  et
  38.   AmigaGuide, ainsi  que  des  fichiers  compactés  à  l'aide  de  l'utilitaire
  39.   "PowerPacker".
  40.  
  41.       Vous pouvez me faire part de vos remarques ou critiques sur ADoc,  en
  42.   écrivant à l'adresse suivante :
  43.  
  44.                 M. GOUNELLE Denis
  45.                     Boîte 71
  46.                    6, rue des cailloux
  47.                   92110 CLICHY - FRANCE
  48.  
  49.       Vous pouvez également m'adresser  un  message  à  l'adresse  Internet
  50.   "gounelle@alphanet.ch". Notez qu'il s'agit d'une boite à  lettre  mise  à  ma
  51.   disposition par un ami, aussi veuillez n'envoyer que de courts  messages.  De
  52.   plus, n'ayant pas accès directement à mes messages, n'espérez pas  avoir  une
  53.   réponse avant une dizaine de jours.
  54.  
  55.       Merci à Jean-Yves PROUX et à Helmut J. ESENWEIN pour leurs nombreuses
  56.   suggestions, à Reza ELGHAZI pour son aide à propos des  fichiers  AmigaGuide,
  57.   ainsi  qu'à  Simon  HEWINSON  pour  la  traduction  en  anglais  du   fichier
  58.   "amiga.doc". Remerciements particuliers à Jean-Philippe RAPP pour ses  idées,
  59.   et pour son aide à propos des fichiers AutoDoc.
  60.  
  61.       En France, la dernière version de ce programme est disponible  auprès
  62.   de Serge HAMMOUCHE, 3 rue Anatole  France,  13220  Chateauneuf-les-Martigues.
  63.   Pour recevoir le catalogue complet, il vous suffit d'envoyer deux  timbres  à
  64.   cette adresse.
  65.  
  66. Installation
  67.  
  68.       ADoc utilise la  bibliothèque  "reqtools.library"  (version  2.0c  ou
  69.   supérieure). Vous devez donc copier cette  bibliothèque  dans  le  répertoire
  70.   "LIBS:", si ce n'est déjà fait.
  71.       ADoc est désormais localisé, c'est-à-dire qu'il peut s'adapter  à  la
  72.   langue par défaut si vous avez le système 2.1 ou plus. Il vous  faudra  alors
  73.   copier le fichier catalogue désiré dans le répertoire correspondant  à  votre
  74.   langue par défaut. Par exemple, s'il s'agit du français,  copiez  le  fichier
  75.   "français.catalog" dans le répertoire "SYS:Locale/Catalogs/Français", sous le
  76.   nom "adoc.catalog"
  77.  
  78. PrincipesDeFonctionnement
  79.  
  80.       ADoc travaille à partir de fichiers de documentation,  qui  associent
  81.   un texte à un mot-clé (appelé "terme" dans  cette  documentation).  A  chaque
  82.   fichier de documentation est associé un fichier d'index, qui permet d'accéder
  83.   presque  instantanément  aux    termes    recherchés  (notez  que  ceci  a   pour
  84.   conséquence  qu'il  faudra  reconstruire  le   fichier   d'index   à   chaque
  85.   modification du fichier de documentation). Seul le fichier d'index est chargé
  86.   en mémoire lors de l'utilisation. Le nom du fichier  d'index  est  obtenu  en
  87.   ajoutant le suffixe ".index" au nom du fichier de documentation.
  88.  
  89.       Les fichiers de documentation, que  vous  pouvez  créer  vous-même  à
  90.   l'aide de votre éditeur de texte  favori,  sont  constitués  d'une  série  de
  91.   définitions, chaque définition ayant la syntaxe suivante :
  92.  
  93.           terme
  94.               première ligne de texte
  95.               seconde ligne de texte
  96.  
  97.               etc...
  98.  
  99.               n-ième ligne de texte
  100.  
  101.       Dans un premier temps, considérez que les deux  premières  lignes  du
  102.   fichier doivent être vides (ou à la rigueur commencer par un  espace  ou  une
  103.   tabulation). Il est absolument indispensable    que  le  premier  caractère  du
  104.   terme soit en colonne 1, et que les lignes de texte commencent par un  espace
  105.   ou une tabulation. Les lignes vides sont autorisées.
  106.  
  107.                 NOTE IMPORTANTE :
  108.  
  109.       Le format des fichiers de documentation n'est plus le même  que  pour
  110.       les version 3.xx et 4.xx.
  111.  
  112.       Un terme ne peut faire plus de 32 caractères, et ne peut contenir  ni
  113.   espaces ni tabulations : les caractères autorisés sont les lettres minuscules
  114.   et majuscules, les chiffres, le souligné et les caractères  accentués  (codes
  115.   ASCII compris entre 217 et 246). Il est cependant possible d'étendre  le  jeu
  116.   des caractères autorisés si besoin (voir paragraphe ConceptsAvancés).
  117.       Le nombre de termes par fichier, et de lignes de texte par terme,  ne
  118.   sont pas limités (ou plutôt, cette limite est si  grande  que  vous  serez  à
  119.   court de mémoire bien avant).
  120.  
  121.       La longueur maximale d'une ligne de texte est de 256 caractères. Afin
  122.   de mettre en valeur certaines parties du  texte,  vous  pouvez  utiliser  les
  123.   séquences ANSI suivantes :
  124.  
  125.           ESC[1m  début caractères gras
  126.           ESC[3m  début caractères italiques
  127.           ESC[4m  début caractères soulignés
  128.           ESC[22m fin caractères gras
  129.           ESC[23m fin caractères italiques
  130.           ESC[24m fin caractères soulignés
  131.           ESC[0m  caractères normaux
  132.  
  133. AppelDepuisLeCLI
  134.  
  135.   ADoc peut s'utiliser aussi bien depuis le CLI que depuis le  Workbench.  Lors
  136.   de l'appel depuis le CLI, vous pouvez indiquer les arguments suivants :
  137.  
  138.   WBENCH
  139.       Demande à ADoc d'utiliser l'écran du Workbench. Si cet argument est omis,
  140.       ADoc ouvrira  son  propre  écran,  de  la  même  taille  que  l'écran  du
  141.       Workbench. En cas d'erreur lors de l'ouverture de cet écran, ADoc passera
  142.       automatiquement sur l'écran du Workbench.
  143.  
  144.   LACE
  145.       Demande à ADoc d'utiliser un  écran  en  mode  entrelacé.  Si  vous  avez
  146.       demandé à utiliser l'écran du Workbench, et que cet écran  n'est  pas  en
  147.       mode entrelacé, cet argument sera ignoré.
  148.  
  149.   FONT nom
  150.       Demande à ADoc d'utiliser la police de caractères indiquée, plutôt que la
  151.       police   par    défaut.     Le    nom    doit    être    de    la      forme
  152.       <NomDeLaPolice><TailleEnY>,  par    exemple  "topaz8".  ADoc  est   capable
  153.       d'utiliser n'importe quelle police non  proportionnelle,  pourvu  que  sa
  154.       taille soit d'au moins 8.
  155.       Si ADoc ne peut ouvrir la police    demandée,  il  essaiera  d'utiliser  la
  156.       police par défaut. Si cette police ne convient pas, ou si  ADoc  ne  peut
  157.       l'ouvrir, il essaiera d'accéder à la police  Topaz,  en  taille  8.  S'il
  158.       échoue, le programme s'arrêtera immédiatement.
  159.  
  160.   MAKEIDX
  161.       Indique à ADoc que la seule opération à effectuer  est  la  création  des
  162.       fichiers d'index.
  163.  
  164.   QUICK
  165.       Demande  à  ADoc    de  ne    pas  afficher  le  texte   associé   au   terme
  166.       "AboutThisDoc" au démarrage. Normalement, à chaque fois que ADoc ouvre un
  167.       fichier, il cherche le terme "AboutThisDoc" dans ce  fichier  puis,  s'il
  168.       existe,  affiche le texte correspondant et attend que l'utilisateur ferme
  169.       la fenêtre pour continuer.
  170.  
  171.   AREXX
  172.       Demande à ADoc de passer en mode    AREXX.    L'utilisation  avec  AREXX  est
  173.       détaillée au paragraphe ModeAREXX.
  174.  
  175.   ONEWINDOW
  176.       Demande à ADoc de n'ouvrir qu'une seule fenêtre à la fois.
  177.  
  178.   NOCASE
  179.       Demande à ADoc de ne pas différencier minuscules et majuscules lors de la
  180.       gestion des fichiers. Cela ne concernera que les fichiers dont le nom est
  181.       indiqué après cette option.
  182.  
  183.   NOSORT
  184.       Demande à ADoc de ne pas trier l'index  des  fichiers  dont  le  nom  est
  185.       indiqué après cette option.
  186.  
  187.   TABSIZE n
  188.       Indique la taille des tabulations pour  les  fichiers  dont  le  nom  est
  189.       indiqué après cette option. La taille par défaut est de 8.
  190.  
  191.   Tout autre argument est considéré comme un nom de fichier de documentation  à
  192.   utiliser. Vous pouvez indiquer plusieurs fichiers, en séparant les  noms  par
  193.   des espaces ou par une virgule (par exemple "ADoc fichier1 fichier2" ou "ADoc
  194.   fichier1,fichier2"). Vous pouvez mélanger noms de fichiers et  options,  mais
  195.   n'oubliez pas que les options NOCASE, NOSORT, et TABSIZE ne concerneront  que
  196.   les fichiers indiqués après ces  options.  ADoc  ouvrira  les  fichiers  dans
  197.   l'ordre indiqué. A moins que vous n'indiquiez un chemin complet, les fichiers
  198.   sont recherchés d'abord dans le répertoire courant, puis dans  le  répertoire
  199.   "ADOC:". Si vous indiquez un nom de répertoire au lieu d'un nom  de  fichier,
  200.   tous les fichiers de ce répertoire (à l'exception  des  fichiers  ".info"  et
  201.   ".index") seront ouverts.
  202.  
  203. AppelDepuisLeWorkbench
  204.  
  205.   Depuis le Workbench, vous pouvez appeler ADoc de plusieurs façons :
  206.  
  207.     - en double-cliquant sur l'icône de ADoc (le fichier de  documentation  par
  208.       défaut sera utilisé)
  209.     - en double-cliquant sur l'icône d'un fichier qui a ADoc  comme  outil  par
  210.       défaut (champ "DEFAULT TOOL")
  211.     - en cliquant sur les icônes de plusieurs  fichiers,  tout    en  gardant  la
  212.       touche SHIFT appuyée, puis en double-cliquant sur l'icône de ADoc.
  213.  
  214.   Dans tous les cas, ADoc commence  par  examiner  le  champ  "TOOL  TYPES"  de
  215.   l'icône du programme, qui peut contenir :
  216.  
  217.       FONT=nom
  218.       OPTIONS=[WBENCH][LACE][MAKEIDX][QUICK][AREXX][ONEWINDOW]
  219.  
  220.   Pour plus de détails sur ces options, voir  le  paragraphe  AppelDepuisLeCLI.
  221.   Notez que les noms des options doivent être séparés  par  un    caractère  "|".
  222.   ADoc ouvre ensuite les  fichiers  de    documentation  éventuellement  indiqués
  223.   exactement de la même façon que lors de l'appel depuis le CLI (notamment vous
  224.   pouvez indiquer un répertoire au lieu d'un fichier), à la différence  que  le
  225.   champ "TOOL TYPES" de chaque icône est examiné, et peut contenir :
  226.  
  227.       TABSIZE=n
  228.       OPTIONS=[NOCASE][NOSORT]
  229.  
  230.   Pour plus de détails sur ces options, voir  le  paragraphe  AppelDepuisLeCLI.
  231.   Notez que ces trois options ne concerneront que le  fichier  correspondant  à
  232.   l'icône.
  233.  
  234. DémarrageDuProgramme
  235.  
  236.       Comme expliqué dans les deux paragraphes  précédents,  ADoc  commence
  237.   par ouvrir le (ou les) fichier(s) indiqué(s). Lors de cette phase, ADoc tente
  238.   également de charger le fichier d'index correspondant  à  chaque  fichier  de
  239.   documentation. Si vous n'avez indiqué aucun nom de  fichier  à  ouvrir,  ADoc
  240.   regarde si la variable "ADocFile"  est  définie  :  si  oui,  sa  valeur  est
  241.   utilisée. Si non, le fichier de documentation  par  défaut  est  "Amiga.doc".
  242.   Notez  que  vous  pouvez  indiquer  plusieurs  fichiers  dans   la   variable
  243.   "ADocFile", de la même façon que depuis la ligne de  commande  (par  exemple:
  244.   setenv ADocFile "exec.doc dos.doc").
  245.       Si le fichier d'index est introuvable,  ADoc  vous  proposera  de  le
  246.   créer. Si vous refusez, ce fichier de documentation ne sera  pas  utilisable,
  247.   mais ADoc essaiera quand même d'ouvrir les autres fichiers.
  248.       Si ADoc détecte que le fichier de documentation a été  modifié  après
  249.   la création de l'index, il vous proposera de  mettre  le  fichier  d'index  à
  250.   jour. Si vous refusez, le fichier de documentation sera  quand  même    ouvert,
  251.   mais ADoc pourra détecter des erreurs ultérieurement    si  le    contenu  de  ce
  252.   fichier a été changé. Notez que la date de création du  fichier  d'index  est
  253.   mémorisée dans le fichier d'index lui-même.
  254.  
  255.       Une fois tous  les  fichiers    ouverts,  ADoc    affiche  une  boîte  de
  256.   requête,  indiquant  la  liste  des  termes  du   premier   fichier    ouvert.
  257.   L'utilisation  de  cette  boîte  de  requête  est   décrite   au   paragraphe
  258.   RequêteDeTerme.
  259.  
  260. RequêteDeTerme
  261.  
  262.       Vous pouvez désigner un terme à l'aide  de  la  souris,  en  cliquant
  263.   dessus. Le terme s'affiche alors dans une autre couleur. Si vous cliquez  une
  264.   seconde fois sur ce terme, la requête disparait  et  ADoc  affiche  le  texte
  265.   correspondant au terme dans une fenêtre. L'utilisation de  ces  fenêtres  est
  266.   décrite au paragraphe GestionDesFenêtres.
  267.  
  268.       Vous pouvez également vous servir du clavier pour faire votre  choix.
  269.   Si vous appuyez sur une lettre  quelconque,  cette  lettre  sera  ajoutée  au
  270.   "préfixe" courant (affiché dans le rectangle  en  dessous  de  la  liste  des
  271.   termes), et l'affichage de la liste des termes se fera à  partir  du  premier
  272.   terme commençant par ce préfixe. ADoc complètera ce préfixe le plus possible.
  273.   Si vous appuyez sur la touche <BACKSPACE> (au-dessus de la touche  <RETURN>),
  274.   le dernier caractère du préfixe sera effacé et l'affichage de la liste mis  à
  275.   jour également. Si vous appuyez sur la touche  <RETURN>,  ADoc  affichera  le
  276.   texte correspondant au premier terme commençant par  le  préfixe.  Notez  que
  277.   ADoc ne différenciera pas  minuscules et majuscules si le fichier  courant  a
  278.   été indiqué après une option NOCASE.
  279.  
  280.       Vous pouvez fermer la requête sans rien choisir, en appuyant    sur  la
  281.   touche <ESC> ou en cliquant sur le  gadget  de  fermeture.  Si  aucune  autre
  282.   fenêtre n'est ouverte à ce moment, le programme s'arrêtera.
  283.  
  284.       La requête de terme est en fait capable de vous  permettre  un  choix
  285.   parmi trois listes : la liste des termes du fichier  courant,  la  liste  des
  286.   fichiers (à condition qu'il y ait plusieurs fichiers ouverts) et la liste des
  287.   termes trouvés lors de la dernière recherche (à  condition  qu'une  recherche
  288.   ait déjà été effectuée, voir paragraphe Recherche). La lettre écrite dans  le
  289.   coin inférieur droit de la requête vous indique quelle liste est  affichée  :
  290.   liste des termes (T), liste des fichiers (F), liste des termes trouvés (S).
  291.       Pour passer d'une liste à l'autre, appuyez sur le bouton droit de  la
  292.   souris tout en appuyant sur une des  touches    SHIFT.    Lorsque  la  liste  des
  293.   fichiers est affichée et que sélectionnez un des  fichiers  de  cette  liste,
  294.   ADoc repasse automatiquement à la liste des termes et affiche  la  liste  des
  295.   termes du fichier que vous avez choisi.
  296.  
  297.       Si aucune autre fenêtre n'est ouverte, la requête  de  terme  dispose
  298.   d'un menu avec quatre options :
  299.  
  300.       Ouvre fichier   voir paragraphe LeMenuSpecial
  301.       Cherche          voir paragraphe Recherche
  302.       Iconifie          voir paragraphe LeMenuProjet
  303.       Quitte          vous permet de quitter ADoc
  304.  
  305. GestionDesFenêtres
  306.  
  307.       Lorsque vous sélectionnez un    terme,    ADoc  ouvre  une  fenêtre  pour
  308.   afficher le texte correspondant. Si le terme est défini plusieurs  fois  dans
  309.   le même fichier, ou dans plusieurs fichiers différents, toutes les lignes  de
  310.   texte seront mises à la suite les unes des  autres,  et  affichées  dans  une
  311.   seule fenêtre. La hauteur  de  la  fenêtre  dépend  du  nombre  de  lignes  à
  312.   afficher. S'il y a trop de lignes, seule la première page  sera  affichée  et
  313.   ADoc ajoutera deux gadgets en forme de flèches (dans le coin supérieur droit)
  314.   à la fenêtre, pour vous permettre de faire défiler le texte.
  315.  
  316.       Bien entendu, il est possible d'avoir plusieurs fenêtres  ouvertes  à
  317.   la fois. Dans ce cas, la fenêtre qui était active lors de  l'ouverture  d'une
  318.   nouvelle fenêtre est considérée comme la fenêtre parente de cette dernière.
  319.       Par  défaut,    les  fenêtres  disposent  des  gadgets     standards   de
  320.   fermeture, de déplacement, de changement de plan, et de changement de taille.
  321.   Si  vous  modifiez  la  taille  d'une  fenêtre,  ADoc  ajoutera  ou  enlevera
  322.   automatiquement les gadgets en forme de flèches suivant les  besoins.  Chaque
  323.   fenêtre dispose également de trois menus, les  menus    "Projet",  "Outils"  et
  324.   "Spécial" (ces menus sont décrits aux paragraphes LeMenuProjet,  LeMenuOutils
  325.   et LeMenuSpécial). Notez enfin que ADoc reconnait les touches suivantes :
  326.  
  327.       HELP          rappelle les touches reconnues
  328.       ESC          ferme la fenêtre courante
  329.       HAUT          page précédente
  330.       BAS          page suivante
  331.       BACKSPACE      ouvre la fenêtre parente
  332.       Shift-HAUT      terme précédent
  333.       Shift-BAS      terme suivant
  334.  
  335.       Si vous cliquez sur un mot quelconque, ce mot sera affiché  dans  une
  336.   couleur différente. Si vous cliquez une seconde fois sur ce mot, ADoc lancera
  337.   automatiquement la recherche du terme correspondant, dans tous  les  fichiers
  338.   ouverts.  En    cas  d'échec  l'écran  flashera,  sinon  une  nouvelle  fenêtre
  339.   apparaitra.
  340.  
  341. LeMenuProjet
  342.  
  343.   Autre terme
  344.       Fait apparaître la requête de terme (voir paragraphe RequêteDeTerme).
  345.  
  346.   Imprime
  347.       Imprime  le  texte  contenu  dans  la  fenêtre  active.  Notez  que   les
  348.       éventuelles  séquences  ANSI   seront   correctement   interprétées   par
  349.       l'imprimante.
  350.  
  351.   Iconifie
  352.       Met ADoc en sommeil : si ADoc avait ouvert son propre écran celui-ci  est
  353.       fermé, puis toutes les fenêtres disparaissent et ADoc  ouvre  une  petite
  354.       fenêtre en haut de l'écran du Workbench. Si vous cliquez sur le gadget de
  355.       fermeture de cette fenêtre, ADoc vous  demandera    confirmation  avant  de
  356.       quitter. Pour "réveiller" ADoc, activez la  fenêtre  et  appuyez  sur  le
  357.       bouton droit de la souris.
  358.       Normalement, ADoc garde en mémoire toutes les lignes  de    texte  afin  de
  359.       pouvoir remettre rapidement toutes les fenêtres  en  place  lors    de  son
  360.       réveil. Ceci a l'inconvénient de ne pas libérer toute la mémoire possible
  361.       aussi, lorsque vous lui demanderez de s'iconifier, ADoc vous demandera si
  362.       vous voulez fermer toutes les fenêtres. Si vous répondez oui, la    mémoire
  363.       sera complètement libérée, et lorsque vous réveillerez ADoc, il affichera
  364.       la requête de terme.
  365.  
  366.   Aide...
  367.       Rappelle quelles touches ADoc reconnait  (équivalent  à  appuyer  sur  la
  368.       touche HELP).
  369.  
  370.   A propos...
  371.       Affiche quelques informations sur  ADoc.    Cliquez  à  l'intérieur  de  la
  372.       fenêtre ou appuyez sur une touche pour continuer.
  373.  
  374.   Quitter
  375.       Vous permet de quitter ADoc (avec confirmation).
  376.  
  377. LeMenuOutils
  378.  
  379.   Ecran avant
  380.       Permet d'utiliser ADoc sur un écran déjà ouvert  (par  exemple  celui  de
  381.       votre éditeur de texte). Il vous suffit de mettre l'écran sur lequel vous
  382.       voulez placer ADoc au premier plan, puis de le faire glisser vers le  bas
  383.       pour dévoiler l'écran où est ADoc. Sélectionnez alors cette option : ADoc
  384.       ferme toutes les fenêtres ouvertes, ferme éventuellement    son  écran,  et
  385.       ré-ouvre les fenêtres sur l'écran au premier plan.
  386.  
  387.                   NOTE IMPORTANTE :
  388.  
  389.       Vous aurez certainement droit à une visite du "Gourou" si l'écran
  390.       où vous avez placé ADoc est fermé avant que  vous  n'ayez  quitté
  391.       ADoc (ou que vous ne l'ayez placé sur un autre écran)
  392.  
  393.       Notez que cette commande ne marchera pas si vous n'avez  pas  indiqué  de
  394.       police de caractères à utiliser (voir paragraphe AppelDepuisLeCLI) et que
  395.       la police de l'écran au premier plan ne convient pas.
  396.  
  397.   Ferme tout
  398.       Vous permet de fermer toutes les fenêtres  d'un  seul  coup.  Après  vous
  399.       avoir demandé confirmation, ADoc fermera les  fenêtres  et  affichera  la
  400.       requête de terme.
  401.  
  402.   Cherche
  403.       Vous permet de lancer une recherche (voir le paragraphe Recherche).
  404.  
  405.   Information
  406.       Affiche le nombre de fichiers et de  termes  disponibles,  ainsi    que  le
  407.       nombre de fenêtres ouvertes et de lignes affichées. Cliquez sur le gadget
  408.       "Ok" pour continuer.
  409.  
  410. LeMenuSpécial
  411.  
  412.   Ouvre fichier
  413.       Vous permet d'ouvrir un  fichier  de  documentation  supplémentaire.  Une
  414.       requête de fichier apparait afin que vous puissiez indiquer le fichier  à
  415.       ouvrir.
  416.  
  417.   Ferme fichier
  418.       Vous permet de fermer le fichier courant (c'est-à-dire le fichier où  est
  419.       défini le terme affiché dans la fenêtre active). Après vous avoir demandé
  420.       confirmation, ADoc fermera toutes les fenêtres correspondant à ce fichier
  421.       puis fermera le fichier.
  422.       Notez que cette commande ne marchera que si au moins deux  fichiers  sont
  423.       ouverts.
  424.  
  425.   Une fenêtre
  426.       Si cette option est sélectionnée, ADoc n'ouvrira qu'une seule  fenêtre  à
  427.       la fois.
  428.  
  429. Recherche
  430.  
  431.       ADoc est capable de chercher    jusqu'à  quatre  chaines  simultanément
  432.   dans les lignes de texte, puis d'afficher la liste des termes correspondants.
  433.   Lorsque vous sélectionnez l'option "Cherche" du menu  "Outils",  une  fenêtre
  434.   apparait avec quatre gadgets de chaine. Il y a également un gadget  "ANNULER"
  435.   pour abandonner l'opération, un gadget "VALIDER" pour lancer la recherche, et
  436.   un menu "Options" :
  437.  
  438.       min = MAJ
  439.       Demande à ADoc de ne pas différencier les minuscules    des  majuscules
  440.       lors de la recherche.
  441.  
  442.       Toutes chaines
  443.       Normalement, ADoc cherche tous les termes  qui  contiennent  une  des
  444.       chaines que vous avez entrées. Cette option vous permet  de  chercher
  445.       au contraire les termes qui contiennent TOUTES les chaines indiquées.
  446.  
  447.       Tous fichiers
  448.       Demande à ADoc de faire la recherche dans tous les fichiers  ouverts,
  449.       et non seulement dans le fichier courant.
  450.  
  451.       Lorsque vous lancez la recherche, une boîte de requête  apparait.  Le
  452.   gadget  "Arrêter"  vous  permet  d'interrompre  la  recherche.  Une  fois  la
  453.   recherche terminée, l'écran flashera si aucun terme n'a été trouvé. Sinon, la
  454.   requête de terme apparaitra, et affichera la liste des termes trouvés.  Cette
  455.   liste est triée, et elle est conservée en mémoire jusqu'à ce que vous lanciez
  456.   une autre recherche.
  457.  
  458. ConceptsAvancés
  459.  
  460.       La version 1.40 de ADoc a introduit la notion  d'alias,  c'est-à-dire
  461.   un moyen de d'associer un même texte  à  plusieurs  termes  différents,  sans
  462.   avoir à répéter le texte plusieurs fois. Pour créer un alias, il vous  suffit
  463.   de définir un terme de la façon suivante :
  464.  
  465.       nom1 alias nom2
  466.  
  467.   Le premier caractère de "nom1" doit, comme pour toute définition de terme, se
  468.   trouver en colonne 1. Il doit y avoir au moins un espace  ou    une  tabulation
  469.   entre les trois mots. Le mot "alias" doit être écrit en  minuscules.  L'effet
  470.   de cette définition est le suivant : si l'utilisateur demande  à  accéder  au
  471.   terme "nom1", ADoc affichera  automatiquement  le  terme  "nom2".  Les  alias
  472.   apparaissent dans la requête de terme, et sont pris en compte par la fonction
  473.   de recherche. Notez qu'il  n'y  a  *AUCUN*  test  de  récursivité  entre  les
  474.   différents alias !
  475.       Une  application  pratique  de  ces  alias   est   par   exemple   la
  476.   documentation d'une  bibliothèque  de  fonctions  :  il  arrive  souvent  que
  477.   plusieurs fonctions soient définies ensemble. Avec le mécanisme des alias  on
  478.   peut accéder à cette définition avec le nom de chaque fonction, alors que  le
  479.   texte n'est défini qu'une seule fois.
  480.  
  481.       ADoc est capable d'associer  automatiquement  plusieurs  fichiers  de
  482.   documentation. Il vous suffit d'indiquer le (ou  les)  noms  des  fichiers  à
  483.   associer sur la première ligne du fichier auquel vous voulez les associer. Si
  484.   cette ligne reste vide, ou commence par un  espace  ou  une  tabulation,  son
  485.   contenu est ignoré. Les noms peuvent être séparés par des espaces ou par  une
  486.   virgule. Vous pouvez indiquer un nom    de  répertoire,  auquel  cas  tous  les
  487.   fichiers de ce répertoire  seront  ouverts  (sauf  les  fichiers  ".info"  et
  488.   ".index").
  489.  
  490.       Pour étendre le jeu des caractères  pouvant  être  utilisés  dans  un
  491.   terme, il vous  suffit  d'indiquer  les  caractères  supplémentaires  sur  le
  492.   seconde ligne du fichier de documentation. Si  cette    ligne  reste  vide,  ou
  493.   commence par un espace ou une tabulation, son contenu est ignoré. Sinon, tous
  494.   les caractères de cette ligne (jusqu'au premier espace, tabulation, barre  de
  495.   fraction ou saut de page) sont ajoutés au jeu de caractères par défaut. Notez
  496.   que cette extension du jeu de caractères ne concernera que ce fichier.
  497.  
  498.       ADoc est capable de charger directement des  fichiers  compactés  par
  499.   "PowerPacker", à  condition  que  la  bibliothèque  "powerpacker.library"  se
  500.   trouve dans le répertoire "LIBS:".  Il  n'est  pas  nécessaire  de  créer  le
  501.   fichier d'index avant le compactage, mais cela est recommandé. ADoc  refusera
  502.   de charger un fichier crypté.
  503.       Après  décompactage,    le  fichier  sera  recopié  dans   un    fichier
  504.   temporaire placé dans le répertoire "T:". L'utilisation de fichiers compactés
  505.   peut donc poser des problèmes de mémoire, particulièrement si  le  répertoire
  506.   "T:" se trouve sur le disque "RAM:". Le fichier temporaire sera détruit après
  507.   sa fermeture.
  508.  
  509. ModeAREXX
  510.  
  511.       ADoc    ouvre  systématiquement  un  port   compatible     AREXX,   nommé
  512.   "ADoc_rexx". Les messages sur ce port sont attendus en  même  temps  que  les
  513.   messages Intuition sur les fenêtres de texte, et peuvent prendre  les  formes
  514.   suivantes :
  515.  
  516.       quit      quitte ADoc
  517.       request fait apparaître la requête de terme
  518.       fscreen ADoc ré-ouvre ses fenêtres sur l'écran au premier plan
  519.       tofront fait passer l'écran de ADoc au premier plan
  520.       toback  fait passer l'écran de ADoc au dernier plan
  521.       ?terme  lance la recherche du terme  indiqué,  et  affiche  le  texte
  522.           correspondant s'il est trouvé
  523.       @fic      ouvre le fichier de documentation indiqué
  524.  
  525.       Le code retour (variable RC) est en général à zéro, sauf dans les cas
  526.   suivants : requête inconnue (code retour 20), requête "?terme" et "terme" non
  527.   trouvé (code retour 5), requête "request" et  pas  de  nouveau  terme  choisi
  528.   (code retour 5). Voici un exemple de programme AREXX, qui demande  de  l'aide
  529.   sur le terme "alias" :
  530.  
  531.       /* Demande de l'aide sur "alias" */
  532.       ADDRESS "ADoc_rexx"
  533.       "?alias"
  534.       IF RC = 5 THEN SAY "not found !"
  535.  
  536.       Notez les guillemets autour des commandes !
  537.       Si vous  lancez  ADoc  avec  l'option  AREXX,  le  fonctionnement  du
  538.   programme sera un peu différent : une fois le(s) fichier(s) de  documentation
  539.   ouvert(s), ADoc n'ouvrira pas la requête de terme mais affichera  le  message
  540.   "En attente d'un message AREXX" et attendra des messages sur  le  port  AREXX
  541.   (ou CTRL-C pour quitter). De plus, lorsque la dernière fenêtre  sera  fermée,
  542.   le programme ne se terminera pas mais repassera en attente de messages AREXX.
  543.  
  544. Support_des_fichiers_AutoDoc
  545.  
  546.       ADoc est capable de reconnaitre et d'utiliser les fichiers AutoDoc de
  547.   Commodore. Dans la plupart des cas, aucune modification de ces fichiers n'est
  548.   nécessaire, mais il est quand même conseillé de vérifier  leur  format  :  il
  549.   doit y avoir au moins deux lignes vides au début, suivies  de  la  table  des
  550.   matières, et chaque terme doit commencer en colonne 1.
  551.       Dans certains cas, il manque les lignes vides au début, et les termes
  552.   commencent en colonne 2, précédés par un caractères "saut de page"  (CTRL-L).
  553.   Le programme "AutoConvert", distribué avec ADoc, vous permettra de  convertir
  554.   ces fichiers au bon format (Note: ce programme ne peut s'utiliser que  depuis
  555.   le CLI). Dans tous les autres cas, il vous faudra convertir les  fichiers  "à
  556.   la main".
  557.  
  558. Support_des_fichiers_AmigaGuide
  559.  
  560.       ADoc est désormais capable de reconnaitre un fichier AmigaGuide, d'en
  561.   construire l'index et d'en afficher le contenu, en  gérant  correctement  les
  562.   différentes formes de la directive @node :
  563.  
  564.       @node nom
  565.       @node "titre"
  566.       @node nom "titre"
  567.  
  568.   Dans ce dernier cas, un alias "nom" est automatiquement défini pour le  terme
  569.   "titre". La directive "@title" est reconnue également.
  570.       Comme ADoc ne permet pas d'utiliser des  espaces  dans  les  noms  de
  571.   termes, ceux-ci sont remplacés par un caractère souligné. Les liens  dans  le
  572.   texte sont affichés en gras. Les noms étant  tronqués  à  32    caractères,  il
  573.   pourra arriver que certains liens ne fonctionnent pas. Notez    que  ADoc  gère
  574.   les liens entre fichiers, comme par exemple :
  575.  
  576.             @{"toto" link help:general/titi}
  577.  
  578.   Pour permettre cela, les délimiteurs sont automatiquement initialisés à ":/."
  579.   pour tous les fichiers AmigaGuide.
  580.  
  581. LesMessagesDeADoc
  582.  
  583.       Lorsqu'une erreur se produit, ADoc affiche dans une petite fenêtre un
  584.   nom (de fichier en général) et un code d'erreur. Ce code d'erreur est soit un
  585.   code    d'erreur  AmigaDOS  soit  un  code  interne.  Dans  le   premier   cas,
  586.   reportez-vous à votre manuel de l'AmigaDOS (ou utilisez la commande  "Fault")
  587.   pour avoir plus de détails sur ce code d'erreur.
  588.       Les codes d'erreur internes sont :
  589.  
  590.       -1      fichier vide
  591.       -2      erreur de lecture
  592.       -3      fichier incorrect (mauvais format, etc...)
  593.       -4      fichier compacté, et "powerpacker.library" absente
  594.       -5      problème lors du décompactage
  595.  
  596.